/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License"),
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup TeeTrusted
 * @{
 *
 * @brief TEE（Trusted Excution Environment）可信执行环境API。
 *
 * 提供安全能力API，例如可信存储、加解密及可信时间等，用于可信应用程序开发。
 *
 * @since 20
 */

/**
 * @file tee_rtc_time_api.h
 *
 * @brief 提供关于rtc定时器的API。
 *
 * @library NA
 * @kit TEEKit
 * @include <TEEKit/tee_rtc_time_api.h>
 * @syscap SystemCapability.Tee.TeeClient
 * @since 20
 */

#ifndef __TEE_RTC_TIME_API_H
#define __TEE_RTC_TIME_API_H

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief 创建一个安全定时器。
 *
 * @param time_seconds 指定安全时长。
 * @param timer_property 指定定时器的属性，仅需指定定时器类型。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         返回其他值表示操作失败。
 * @since 20
 */
TEE_Result tee_ext_create_timer(uint32_t time_seconds, TEE_timer_property *timer_property);

/**
 * @brief 销毁一个安全定时器。
 *
 * @param timer_property 指定定时器的属性，仅需指定定时器类型。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         返回其他值表示操作失败。
 * @since 20
 */
TEE_Result tee_ext_destory_timer(TEE_timer_property *timer_property);

/**
 * @brief 获取设定的定时时长。
 *
 * @param timer_property 指定定时器的属性，仅需指定定时器类型。
 * @param time_seconds 指定定时时长。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         返回其他值表示操作失败。
 * @since 20
 */
TEE_Result tee_ext_get_timer_expire(TEE_timer_property *timer_property, uint32_t *time_seconds);

/**
 * @brief 获取剩余的定时时长。
 *
 * @param timer_property 指定定时器的属性，仅需指定定时器类型。
 * @param time_seconds 指定剩余定时时长。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         返回其他值表示操作失败。
 * @since 20
 */
TEE_Result tee_ext_get_timer_remain(TEE_timer_property *timer_property, uint32_t *time_seconds);

/**
 * @brief 获取当前RTC时钟的时间。
 * @attention 获取的时间是秒数，无法转换为通用时间。
 *
 * @return RTC时钟计数（秒数）。
 * @since 20
 */
unsigned int tee_get_secure_rtc_time(void);

#ifdef __cplusplus
}
#endif

#endif
/** @} */